4.2 更新本地用户角色

基本信息

Path: /api/v2/localUserRole/update

Method: POST

接口描述:

  1. 对于更新接口中的非必须参数,如果不传,不会对该条数据相对应参数进行修改
  2. 需要关联"适用对象"->"组织架构"时,使用 groupNameList 可能导致关联到多个同名组织架构,后续将不再维护此参数,建议使用 groupFullPathList 作为替代
  3. 根据id更新时,支持修改角色名;根据name更新时,不支持修改角色名。

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 必须  

Body

根据id更新

名称 类型 是否必须 默认值 备注 其他信息
id string 必须 角色ID
name string 非必须 角色名
description string 非必须 描述
userIdEditWay string 非必须 'set' 用户编辑方式,'set'重置,'append'追加,'delete'删除
userIdList string[] 非必须 用户ID列表
userNameList string[] 非必须 用户名列表 如果没有传userIdList,会以userNameList为准
resourceIdEditWay string 非必须 'set' 应用编辑方式,'set'重置,'append'追加,'delete'删除
resourceIdList string[] 非必须 应用ID列表 resourceIdList和resourceNameList只传一个即可,都传时以resourceIdList为准
resourceNameList string[] 非必须 应用名列表 resourceIdList和resourceNameList只传一个即可,都传时以resourceIdList为准
resourceGroupIdEditWay string 非必须 'set' 应用分类编辑方式,'set'重置,'append'追加,'delete'删除
resourceGroupIdList string[] 非必须 应用分类ID列表 resourceGroupIdList和resourceGroupNameList只传一个即可,都传时以resourceGroupIdList为准
resourceGroupNameList string[] 非必须 应用分类名列表 resourceGroupIdList和resourceGroupNameList只传一个即可,都传时以resourceGroupIdList为准
groupIdEditWay string 非必须 'set' 组织架构编辑方式,'set'重置,'append'追加,'delete'删除
groupIdList string[] 非必须 适用对象-组织架构ID列表 与groupNameList、groupFullPathList只传一个即可,传多个参数时优先级为:groupIdList > groupFullPathList > groupNameList
groupFullPathList string[] 非必须 适用对象-组织架构全路径列表,如:["/a/b", "/a/c"] 与groupIdList、groupNameList只传一个即可
groupNameList string[] 非必须 (不再维护)适用对象-组织架构名列表,如:["b", "c"] 与groupIdList、groupFullPathList只传一个即可

根据name更新

名称 类型 是否必须 默认值 备注 其他信息
name string 必须 角色名
description string 非必须 描述
userIdEditWay string 非必须 'set' 用户编辑方式,'set'重置,'append'追加,'delete'删除
userIdList string[] 非必须 用户ID列表
userNameList string[] 非必须 用户名列表 如果没有传userIdList,会以userNameList为准
resourceIdEditWay string 非必须 'set' 应用编辑方式,'set'重置,'append'追加,'delete'删除
resourceIdList string[] 非必须 应用ID列表
resourceNameList string[] 非必须 应用名列表 如果没有传resourceIdList,会以resourceNameList为准
resourceGroupIdEditWay string 非必须 'set' 应用分类编辑方式,'set'重置,'append'追加,'delete'删除
resourceGroupIdList string[] 非必须 应用分类ID列表
resourceGroupNameList string[] 非必须 应用分类名列表 如果没有传resourceGroupIdList,会以resourceGroupNameList为准
groupIdEditWay string 非必须 'set' 组织架构编辑方式,'set'重置,'append'追加,'delete'删除
groupIdList string[] 非必须 适用对象-组织架构ID列表 与groupNameList、groupFullPathList只传一个即可,传多个参数时优先级为:groupIdList > groupFullPathList > groupNameList
groupFullPathList string[] 非必须 适用对象-组织架构全路径列表,如:["/a/b", "/a/c"] 与groupIdList、groupNameList只传一个即可
groupNameList string[] 非必须 (该字段不再维护)适用对象-组织架构名列表,如:["b", "c"] 与groupIdList、groupFullPathList只传一个即可

请求示例

{
    "userIdEditWay": "set",
    "resourceIdEditWay": "set",
    "resourceGroupIdEditWay": "set",
    "name": "userGroup",
    "description": "",
    "userIdList": [
        "999b7740-8861-11eb-b91e-f19499d7b5ed",
        "591147c0-a7c6-11eb-ab50-3d5656bab316",
        "baf65f80-6846-11eb-a7e5-57c537ca6be9",
        "5c3294d0-580d-11eb-973d-236e909a29fd",
        "2f0a59e0-8790-11eb-af27-5b79f73340b7"
    ],
    "groupIdList": [
        "4c3294d0-580d-11eb-973d-236e909a29fd",
        "491147c0-a7c6-11eb-ab50-3d5656bab316"
    ],
    "resourceGroupIdList": [],
    "resourceIdList": []
}

返回数据

名称 类型 是否必须 默认值 备注 其他信息
code number 必须 错误码,非0表示错误,具体含义请参考错误码定义
data object 必须 返回内容
msg string 必须 描述信息  

返回示例

{
    "code": 0,
    "data": {},
    "msg": "请求成功"
}

错误信息

错误提示 错误码
用户编辑方式只能是追加,删除或者重置 7201
组织架构列表编辑方式只能是追加,删除或者重置 7201
资源编辑方式只能是追加,删除或者重置 7201
资源组编辑方式只能是追加,删除或者重置 7201
参数检查出错 10000001
操作失败,对象不存在或已被其他管理员删除 77200004
部分角色数据已经删除,请重新选择 10000000
角色名称(%s)已存在 77200005
部分组织架构数据已经删除,请重新选择 10000001
本地用户组织架构不存在 77200001
LocalUser不存在 77200004
Resource不存在 77200004
ResourceGroup不存在 77200004
服务器内部错误 10000000
深信服科技 all right reserved,powered by Gitbook本文档更新于: 2024-05-18 14:38

results matching ""

    No results matching ""